Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
prosemirror-tables
Advanced tools
The prosemirror-tables package provides a set of tools for working with tables in the ProseMirror editor. It allows you to create, edit, and manipulate tables within your ProseMirror-based text editor.
Creating a Table
This code demonstrates how to create a table using the prosemirror-tables package. It extends the basic ProseMirror schema to include table nodes and then creates a table node.
const { schema } = require('prosemirror-schema-basic');
const { tableNodes, addTableNodes } = require('prosemirror-tables');
const { Schema } = require('prosemirror-model');
const mySchema = new Schema({
nodes: addTableNodes(schema.spec.nodes, 'table', 'block'),
marks: schema.spec.marks
});
const table = mySchema.nodes.table.createAndFill();
Adding a Row
This code shows how to add a row to an existing table in the ProseMirror editor. The addRow function is used to insert a new row at the current selection.
const { addRow } = require('prosemirror-tables');
function addRowToTable(state, dispatch) {
const { tr } = state;
dispatch(tr.setSelection(state.selection));
dispatch(addRow(tr, state.selection.$anchorCell.pos));
}
Deleting a Column
This code demonstrates how to delete a column from a table in the ProseMirror editor. The deleteColumn function is used to remove the column at the current selection.
const { deleteColumn } = require('prosemirror-tables');
function deleteColumnFromTable(state, dispatch) {
const { tr } = state;
dispatch(tr.setSelection(state.selection));
dispatch(deleteColumn(tr, state.selection.$anchorCell.pos));
}
Merging Cells
This code shows how to merge selected cells in a table. The mergeCells function is used to combine the selected cells into a single cell.
const { mergeCells } = require('prosemirror-tables');
function mergeSelectedCells(state, dispatch) {
const { tr } = state;
dispatch(tr.setSelection(state.selection));
dispatch(mergeCells(tr));
}
Tiptap is a headless, framework-agnostic text editor built on top of ProseMirror. It provides a rich set of extensions, including table support, which allows for similar table creation and manipulation functionalities as prosemirror-tables. Tiptap is known for its ease of use and flexibility in integrating with various frameworks.
CKEditor 5 is a modern JavaScript rich text editor with a modular architecture. It includes a table plugin that offers comprehensive table editing capabilities, such as creating, resizing, merging, and splitting cells. CKEditor 5 is highly customizable and provides a user-friendly interface for table manipulation.
Quill is a powerful, free, open-source WYSIWYG editor with a focus on extensibility and customization. It has a table module that allows users to create and edit tables within the editor. While Quill's table functionalities are not as extensive as those in prosemirror-tables, it provides a straightforward way to handle basic table operations.
This module defines a schema extension to support tables with rowspan/colspan support, a custom selection class for cell selections in such a table, a plugin to manage such selections and enforce invariants on such tables, and a number of commands to work with tables.
The top-level directory contains a demo.js
and index.html
, which
can be built with pnpm run build_demo
to show a simple demo of how the
module can be used.
The module's main file exports everything you need to work with it.
The first thing you'll probably want to do is create a table-enabled
schema. That's what tableNodes
is for:
tableNodes
(options: Object) → Object
This function creates a set of node
specs for
table
, table_row
, and table_cell
nodes types as used by this
module. The result can then be added to the set of nodes when
creating a a schema.
options
: Object
The following options are understood:
tableGroup
: ?string
A group name (something like "block"
) to add to the table
node type.
cellContent
: string
The content expression for table cells.
cellAttributes
: ?Object
Additional attributes to add to cells. Maps attribute names to
objects with the following properties:
default
: any
The attribute's default value.
getFromDOM
: ?fn(dom.Node) → any
A function to read the attribute's value from a DOM node.
setDOMAttr
: ?fn(value: any, attrs: Object)
A function to add the attribute's value to an attribute
object that's used to render the cell's DOM.
tableEditing
() → Plugin
Creates a plugin
that, when added to an editor, enables cell-selection, handles
cell-based copy/paste, and makes sure tables stay well-formed (each
row has the same width, and cells don't overlap).
You should probably put this plugin near the end of your array of plugins, since it handles mouse and arrow key events in tables rather broadly, and other plugins, like the gap cursor or the column-width dragging plugin, might want to get a turn first to perform more specific behavior.
A Selection
subclass that represents a cell selection spanning part of a table.
With the plugin enabled, these will be created when the user
selects across cells, and will be drawn by giving selected cells a
selectedCell
CSS class.
new
CellSelection
($anchorCell: ResolvedPos, $headCell: ?ResolvedPos = $anchorCell)
A table selection is identified by its anchor and head cells. The
positions given to this constructor should point before two
cells in the same table. They may be the same, to select a single
cell.
$anchorCell
: ResolvedPos
A resolved position pointing in front of the anchor cell (the one
that doesn't move when extending the selection).
$headCell
: ResolvedPos
A resolved position pointing in front of the head cell (the one
moves when extending the selection).
content
() → Slice
Returns a rectangular slice of table rows containing the selected
cells.
isColSelection
() → bool
True if this selection goes all the way from the top to the
bottom of the table.
isRowSelection
() → bool
True if this selection goes all the way from the left to the
right of the table.
static
colSelection
($anchorCell: ResolvedPos, $headCell: ?ResolvedPos = $anchorCell) → CellSelection
Returns the smallest column selection that covers the given anchor
and head cell.
static
rowSelection
($anchorCell: ResolvedPos, $headCell: ?ResolvedPos = $anchorCell) → CellSelection
Returns the smallest row selection that covers the given anchor
and head cell.
static
create
(doc: Node, anchorCell: number, headCell: ?number = anchorCell) → CellSelection
The following commands can be used to make table-editing functionality available to users.
addColumnBefore
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Command to add a column before the column with the selection.
addColumnAfter
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Command to add a column after the column with the selection.
deleteColumn
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Command function that removes the selected columns from a table.
addRowBefore
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Add a table row before the selection.
addRowAfter
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Add a table row after the selection.
deleteRow
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Remove the selected rows from a table.
mergeCells
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Merge the selected cells into a single cell. Only available when
the selected cells' outline forms a rectangle.
splitCell
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Split a selected cell, whose rowpan or colspan is greater than one,
into smaller cells. Use the first cell type for the new cells.
splitCellWithType
(getType: fn({row: number, col: number, node: Node}) → NodeType) → fn(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Split a selected cell, whose rowpan or colspan is greater than one,
into smaller cells with the cell type (th, td) returned by getType function.
setCellAttr
(name: string, value: any) → fn(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Returns a command that sets the given attribute to the given value,
and is only available when the currently selected cell doesn't
already have that attribute set to that value.
toggleHeaderRow
(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Toggles whether the selected row contains header cells.
toggleHeaderColumn
(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Toggles whether the selected column contains header cells.
toggleHeaderCell
(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Toggles whether the selected cells are header cells.
toggleHeader
(type: string, options: ?{useDeprecatedLogic: bool}) → fn(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Toggles between row/column header and normal cells (Only applies to first row/column).
For deprecated behavior pass useDeprecatedLogic
in options with true.
goToNextCell
(direction: number) → fn(EditorState, dispatch: ?fn(tr: Transaction)) → bool
Returns a command for selecting the next (direction=1) or previous
(direction=-1) cell in a table.
deleteTable
(state: EditorState, dispatch: ?fn(tr: Transaction)) → bool
Deletes the table around the selection, if any.
fixTables
(state: EditorState, oldState: ?EditorState) → ?Transaction
oldState
was
provided, that is assumed to hold a previous, known-good state,
which will be used to avoid re-scanning unchanged parts of the
document.A table map describes the structore of a given table. To avoid recomputing them all the time, they are cached per table node. To be able to do that, positions saved in the map are relative to the start of the table, rather than the start of the document.
width
: number
The width of the table
height
: number
The table's height
map
: [number]
A width * height array with the start position of
the cell covering that part of the table in each slot
findCell
(pos: number) → Rect
Find the dimensions of the cell at the given position.
colCount
(pos: number) → number
Find the left side of the cell at the given position.
nextCell
(pos: number, axis: string, dir: number) → ?number
Find the next cell in the given direction, starting from the cell
at pos
, if any.
rectBetween
(a: number, b: number) → Rect
Get the rectangle spanning the two given cells.
cellsInRect
(rect: Rect) → [number]
Return the position of all cells that have the top left corner in
the given rectangle.
positionAt
(row: number, col: number, table: Node) → number
Return the position at which the cell at the given row and column
starts, or would start, if a cell started there.
static
get
(table: Node) → TableMap
Find the table map for the given table node.
FAQs
ProseMirror's rowspan/colspan tables component
The npm package prosemirror-tables receives a total of 1,251,122 weekly downloads. As such, prosemirror-tables popularity was classified as popular.
We found that prosemirror-tables demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.